<?php
/*
 * Copyright (c) 2008 Sergey Bondari, bondari@bondari.net
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Mosaic\System;


/**
 * Nodes handshake
 *
 * Request for node ping. Used in node handshaking. Response is node name.
 *
 * @package System
 * @subpackage Requests
 */
class PingRequest extends Request {
	protected $__REQUEST_TYPE = RequestType::PING;

	protected $name;

	function __construct($name) {
		parent::__construct();
		$this->name = $name;
	}

	/**
	 * Node name getter
	 *
	 * @return string Node name
	 */
	public function getNodeName() {
		return $this->name;
	}

	/**
	 * Serializes instance into the MCGI packet
	 *
	 * @return \Mosaic\MCGI\Packet
	 */
	public function createMCGIPacket() {
		$mcgi = parent::createMCGIPacket();
		$mcgi->setHeader('NODE_NAME', $this->getNodeName());
		return $mcgi;
	}
	

	/**
	 * Unserializes instance from MCGI packet
	 *
	 * @param \Mosaic\MCGI\Packet
	 * @return void
	 */
	public function fillFromMCGIPacket($mcgi) {
		$this->name = $mcgi->getHeader('NODE_NAME');
		parent::fillFromMCGIPacket($mcgi);
	}

	
}

